Repository navigation
docs(readme): lead with a pitch, diagram and quick start - #107
Conversation
The README opened with a 25-line provider list and a long feature catalogue, so a first-time reader had to scroll to learn what the project is or how to run it. The top now states the purpose in one line, shows the request path as a diagram, and gives a quick start verified against a fresh environment. The provider list moves into a collapsed block; the feature list and everything after it is unchanged.
|
Important
This repository does not receive automatic reviews because it has fewer than 10 stars.
|
Codex Review Summary: ✅ CompletedThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: a321d2a2ae
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| export ADMIN_USERNAME=admin ADMIN_API_KEY=choose-a-long-key | ||
| export FLASK_SECRET_KEY=change-me JWT_SECRET=change-me-too | ||
| export GROQ_API_KEY_1=your-groq-key | ||
| python app.py # listens on http://localhost:1400 |
There was a problem hiding this comment.
Generate unique secrets in the quick-start commands
When a reader copies this quick start and supplies their Groq key, the server starts with publicly known administrator and session-signing secrets: security_config.py accepts these placeholder values, and app.py defaults to binding 0.0.0.0, not just localhost. On a machine with port 1400 reachable, another user can authenticate with choose-a-long-key and make requests charged to the configured provider account. Generate random secrets in the example and reuse the generated admin key in the curl command; explicitly bind the local quick start to loopback as well.
Useful? React with 👍 / 👎.
Rewrites the top of the README so a first-time reader sees what the gateway is, how requests flow through it, and how to run it in about a minute.
/healthzreturns 200 and the admin key authenticatesI confirm I have the right to send this contribution under the terms in CONTRIBUTING.md.